/*
 * Copyright (c) 2011 Obix Labs Limited
 * Redistribution and use in source and binary forms, 
 * with or without modification, are permitted provided 
 * that the following conditions are met:
 * 
 * 		Redistribution of source code must retain the above 
 * 		copyright notice, this list of conditions and the 
 * 		following disclaimer.
 *
 * 		Redistribution in binary form must reproduce the 
 * 		above copyright notice, this list of conditions 
 * 		and the following disclaimer in the documentation 
 * 		and/or other materials provided with the distribution.
 * 
 * 	THIS SOFTWARE IS PROVIDED "AS IS," WITHOUT A WARRANTY OF 
 * 	ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS 
 * 	AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, 
 * 	FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, 
 * 	ARE HEREBY EXCLUDED. OBIX LABS LIMITED ("Obix Labs") AND ITS 
 * 	LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE 
 * 	AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR 
 * 	ITS DERIVATIVES. IN NO EVENT WILL Obix Labs OR ITS LICENSORS BE 
 * 	LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, 
 * 	INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE 
 * 	DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF 
 * 	LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE THIS 
 * 	SOFTWARE, EVEN IF Obix Labs HAS BEEN ADVISED OF THE POSSIBILITY OF 
 * 	SUCH DAMAGES.
 */
package com.obixlabs.commons.testutil;

import java.util.Collection;

import org.junit.Ignore;

/*
 * <p>
 * Utility class which provides helper methods
 * to simplify the use of collections in tests.
 * </p>
 */
@Ignore
public final class CollectionTestUtil
{
	/*
	 * <p>
	 * Private constructor to prevent accidental 
	 * initialisation of utility class.
	 * </p> 
	 */
	private CollectionTestUtil(){}
	
	/*
	 * Tests that the given collections are equal. Two collections
	 * are considered equal if both are the same size and either 
	 * of them can be shown to be a subset of the other.
	 *  
	 * @param lhs	The left-side of the comparison.
	 * @param rhs	The right-side of the comparison.
	 * 
	 * @return	<code>True</code> if the given collections 
	 * are equal and <code>False</code> otherwise.
	 */
	public static boolean collectionsEqual(Collection<?> lhs, Collection<?> rhs)
	{
		boolean result = false;
		
		if (lhs.size() == rhs.size() && 
				lhs.containsAll(rhs))
			result = true;
		
		return result;
	}	
}
